<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>HuffTree xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/com/totsp/gwittir/client/util/compress/HuffTree.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * To change this template, choose Tools | Templates</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * and open the template in the editor.</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> */</em>
<a name="5" href="#5">5</a>   
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">package</strong> com.totsp.gwittir.client.util.compress;
<a name="7" href="#7">7</a>   
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment">/**</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * @author kebernet</em>
<a name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> */</em>
<a name="12" href="#12">12</a>  <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../com/totsp/gwittir/client/util/compress/HuffTree.html">HuffTree</a> implements Comparable{
<a name="13" href="#13">13</a>  
<a name="14" href="#14">14</a>    <strong class="jxr_keyword">int</strong> frequency;
<a name="15" href="#15">15</a>  
<a name="16" href="#16">16</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getFrequency(){
<a name="17" href="#17">17</a>      <strong class="jxr_keyword">return</strong> frequency;
<a name="18" href="#18">18</a>    }<em class="jxr_comment">//end getFrequency</em>
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>    <em class="jxr_comment">//This method compares this object to an object whose</em>
<a name="21" href="#21">21</a>    <em class="jxr_comment">// reference is received as an incoming parameter.</em>
<a name="22" href="#22">22</a>    <em class="jxr_comment">// The method guarantees that sorting processes that</em>
<a name="23" href="#23">23</a>    <em class="jxr_comment">// depend on this method, such as TreeSet objects, will</em>
<a name="24" href="#24">24</a>    <em class="jxr_comment">// sort the objects into a definitive order.</em>
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>    <em class="jxr_comment">// If the frequency values of the two objects are</em>
<a name="27" href="#27">27</a>    <em class="jxr_comment">// different, the sort is based on the frequency values.</em>
<a name="28" href="#28">28</a>    <em class="jxr_comment">// If the frequency values are equal, the objects are</em>
<a name="29" href="#29">29</a>    <em class="jxr_comment">// sorted based on their relative hashCode values.</em>
<a name="30" href="#30">30</a>    <em class="jxr_comment">// Thus, if the same two objects with the same frequency</em>
<a name="31" href="#31">31</a>    <em class="jxr_comment">// value are compared two or more times during the</em>
<a name="32" href="#32">32</a>    <em class="jxr_comment">// execution of the program, those two objects will</em>
<a name="33" href="#33">33</a>    <em class="jxr_comment">// always be sorted into the same order.  There is no</em>
<a name="34" href="#34">34</a>    <em class="jxr_comment">// chance of an ambiguous tie as to which object</em>
<a name="35" href="#35">35</a>    <em class="jxr_comment">// should be first except for the case where an object</em>
<a name="36" href="#36">36</a>    <em class="jxr_comment">// is compared to itself using two references to the</em>
<a name="37" href="#37">37</a>    <em class="jxr_comment">// same object.</em>
<a name="38" href="#38">38</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compareTo(Object obj){
<a name="39" href="#39">39</a>      <a href="../../../../../../com/totsp/gwittir/client/util/compress/HuffTree.html">HuffTree</a> theTree = (HuffTree)obj;
<a name="40" href="#40">40</a>      <strong class="jxr_keyword">if</strong> (frequency == theTree.frequency){
<a name="41" href="#41">41</a>        <em class="jxr_comment">//The objects are in a tie based on the frequency</em>
<a name="42" href="#42">42</a>        <em class="jxr_comment">// value.  Return a tiebreaker value based on the</em>
<a name="43" href="#43">43</a>        <em class="jxr_comment">// relative hashCode values of the two objects.</em>
<a name="44" href="#44">44</a>        <strong class="jxr_keyword">return</strong> (hashCode() - theTree.hashCode());
<a name="45" href="#45">45</a>      }<strong class="jxr_keyword">else</strong>{
<a name="46" href="#46">46</a>        <em class="jxr_comment">//Return negative or positive as this frequency is</em>
<a name="47" href="#47">47</a>        <em class="jxr_comment">// less than or greater than the frequency value of</em>
<a name="48" href="#48">48</a>        <em class="jxr_comment">// the object referred to by the parameter.</em>
<a name="49" href="#49">49</a>        <strong class="jxr_keyword">return</strong> frequency - theTree.frequency;
<a name="50" href="#50">50</a>      }<em class="jxr_comment">//end else</em>
<a name="51" href="#51">51</a>    }<em class="jxr_comment">//end compareTo</em>
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

